<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>robot_interfaces: robot_interfaces::RobotFrontend&lt; Action, Observation &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">robot_interfaces
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classrobot__interfaces_1_1RobotFrontend.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classrobot__interfaces_1_1RobotFrontend-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">robot_interfaces::RobotFrontend&lt; Action, Observation &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Communication link between <a class="el" href="classrobot__interfaces_1_1RobotData.html" title="Contains all the input and output data of the robot. ">RobotData</a> and the user.  
 <a href="classrobot__interfaces_1_1RobotFrontend.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="robot__frontend_8hpp_source.html">robot_frontend.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af6a72462c774a657fa0fb8c2d2200223"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6a72462c774a657fa0fb8c2d2200223"></a>
typedef Timeseries&lt; int &gt;::Timestamp&#160;</td><td class="memItemRight" valign="bottom"><b>TimeStamp</b></td></tr>
<tr class="separator:af6a72462c774a657fa0fb8c2d2200223"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5461c0645357018a0c7718cdfbacd01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5461c0645357018a0c7718cdfbacd01"></a>
typedef <a class="el" href="classrobot__interfaces_1_1RobotBackend.html">RobotBackend</a>&lt; Action, Observation &gt;::<a class="el" href="structrobot__interfaces_1_1RobotBackend_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Status</b></td></tr>
<tr class="separator:af5461c0645357018a0c7718cdfbacd01"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4fcef139e079fb707c1ad76fcf4c6c62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fcef139e079fb707c1ad76fcf4c6c62"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RobotFrontend</b> (std::shared_ptr&lt; <a class="el" href="classrobot__interfaces_1_1RobotData.html">RobotData</a>&lt; Action, Observation, <a class="el" href="structrobot__interfaces_1_1RobotBackend_1_1Status.html">Status</a> &gt;&gt; robot_data)</td></tr>
<tr class="separator:a4fcef139e079fb707c1ad76fcf4c6c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7628a6f8d6858bb42565ad3577b9d5f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7628a6f8d6858bb42565ad3577b9d5f0"></a>
Observation&#160;</td><td class="memItemRight" valign="bottom"><b>get_observation</b> (const TimeIndex &amp;t)</td></tr>
<tr class="separator:a7628a6f8d6858bb42565ad3577b9d5f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9cf328a6a438cf40df1944c1772fca8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9cf328a6a438cf40df1944c1772fca8"></a>
Action&#160;</td><td class="memItemRight" valign="bottom"><b>get_desired_action</b> (const TimeIndex &amp;t)</td></tr>
<tr class="separator:ad9cf328a6a438cf40df1944c1772fca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52f915a23cd37e4c108080ed5cba674a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52f915a23cd37e4c108080ed5cba674a"></a>
Action&#160;</td><td class="memItemRight" valign="bottom"><b>get_applied_action</b> (const TimeIndex &amp;t)</td></tr>
<tr class="separator:a52f915a23cd37e4c108080ed5cba674a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaf909237a40a0da1839d5e341ad572b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abaf909237a40a0da1839d5e341ad572b"></a>
TimeStamp&#160;</td><td class="memItemRight" valign="bottom"><b>get_time_stamp_ms</b> (const TimeIndex &amp;t)</td></tr>
<tr class="separator:abaf909237a40a0da1839d5e341ad572b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d74aa3bd15ab0baef5d011f06aad7e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d74aa3bd15ab0baef5d011f06aad7e7"></a>
TimeIndex&#160;</td><td class="memItemRight" valign="bottom"><b>get_current_timeindex</b> ()</td></tr>
<tr class="separator:a3d74aa3bd15ab0baef5d011f06aad7e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26c137f65b908d6eddffff75df38361a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c137f65b908d6eddffff75df38361a"></a>
TimeIndex&#160;</td><td class="memItemRight" valign="bottom"><b>append_desired_action</b> (const Action &amp;desired_action)</td></tr>
<tr class="separator:a26c137f65b908d6eddffff75df38361a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b5242a6781e6028a84a6eb358b1ad10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b5242a6781e6028a84a6eb358b1ad10"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>wait_until_timeindex</b> (const TimeIndex &amp;t)</td></tr>
<tr class="separator:a9b5242a6781e6028a84a6eb358b1ad10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Action, typename Observation&gt;<br />
class robot_interfaces::RobotFrontend&lt; Action, Observation &gt;</h3>

<p>Communication link between <a class="el" href="classrobot__interfaces_1_1RobotData.html" title="Contains all the input and output data of the robot. ">RobotData</a> and the user. </p>
<p>Takes care of communication between the <a class="el" href="classrobot__interfaces_1_1RobotData.html" title="Contains all the input and output data of the robot. ">RobotData</a> and the user. It is just a thin wrapper around <a class="el" href="classrobot__interfaces_1_1RobotData.html" title="Contains all the input and output data of the robot. ">RobotData</a> to facilitate interaction and also to make sure the user cannot use <a class="el" href="classrobot__interfaces_1_1RobotData.html" title="Contains all the input and output data of the robot. ">RobotData</a> in incorrect ways.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Action</td><td></td></tr>
    <tr><td class="paramname">Observation</td><td></td></tr>
  </table>
  </dd>
</dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>/workspace/software/workspace/src/catkin/robots/robot_interfaces/include/robot_interfaces/<a class="el" href="robot__frontend_8hpp_source.html">robot_frontend.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>robot_interfaces</b></li><li class="navelem"><a class="el" href="classrobot__interfaces_1_1RobotFrontend.html">RobotFrontend</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
